/*
 * #!
 * Ontopia Engine
 * #-
 * Copyright (C) 2001 - 2013 The Ontopia Project
 * #-
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * !#
 */

package net.ontopia.topicmaps.impl.utils;

import java.io.IOException;
import java.io.PushbackInputStream;

/**
 * INTERNAL: An object which can guess the encoding of an input stream
 * by peeking into its contents. Sniffers are specific to a syntax.
 */
public interface EncodingSnifferIF {

  /**
   * INTERNAL: By examining the contents of the stream, guess the
   * encoding used.
   * @return the name of the encoding
   */
  String guessEncoding(PushbackInputStream stream) throws IOException;
  
}
